|
Menu location |
---|
Annotation → Text |
Workbenches |
Draft, BIM |
Default shortcut |
T E |
Introduced in version |
0.7 |
See also |
Draft Label, Draft ShapeString |
The Draft Text command creates a multi-line text at a given point.
To create a text element with an arrow use the Draft Label command instead.
Single point required to position the text
See also: Draft Tray and Draft Snap.
The single character keyboard shortcuts available in the task panel can be changed. See Draft Preferences. The shortcuts mentioned here are the default shortcuts (for version 1.0).
See also: Property editor.
A Draft Text object is derived from an App FeaturePython object and inherits all its properties. The following properties are additional unless otherwise stated.
Base
Placement
): specifies the position of the text in the 3D view. See Placement.StringList
): specifies the contents of the text. Each item in the list represents a new text line.
Annotation
Enumeration
): specifies the annotation style applied to the text. See Draft AnnotationStyleEditor.Float
): specifies the general scaling factor applied to the text.Display Options
Enumeration
): specifies how the text is displayed. If it is World
the text will be displayed on a plane defined by its DadosPlacement. If it is Screen
the text will always face the screen. This is an inherited property. The mentioned options are the renamed options (introduced in version 0.21).Graphics
Color
): not used.Float
): not used.Text
Font
): specifies the font used to draw the text. It can be a font name, such as Arial
, a default style such as sans
, serif
or mono
, a family such as Arial,Helvetica,sans
, or a name with a style such as Arial:Bold
. If the given font is not found on the system, a default font is used instead.Length
): specifies the size of the letters. The text can be invisible in the 3D view if this value is very small.Enumeration
): specifies if the alignment of the text: Left
, Center
or Right
.Float
): specifies the factor applied to the default line height of the text.Color
): specifies the color of the text.See also: Autogenerated API documentation and FreeCAD Scripting Basics.
To create a Draft Text use the make_text
method (introduced in version 0.19) of the Draft module. This method replaces the deprecated makeText
method.
text = make_text(string, placement=None, screen=False)
text
object, at placement
, which can be a FreeCAD.Placement
, but also a FreeCAD.Rotation
or a FreeCAD.Vector
.string
is a string or a list of strings. If it is a list, each element is displayed on its own line.screen
is True
, the text always faces the camera, otherwise it is displayed in a plane defined by its DadosPlacement.The view properties of text
can be changed by overwriting its attributes; for example, overwrite ViewObject.FontSize
with the new size in millimeters.
Example:
import FreeCAD as App
import Draft
doc = App.newDocument()
t1 = "This is a sample text"
p1 = App.Vector(0, 0, 0)
t2 = ["First line", "second line"]
p2 = App.Vector(1000, 1000, 0)
text1 = Draft.make_text(t1, p1)
text2 = Draft.make_text(t2, p2)
text1.ViewObject.FontSize = 200
text2.ViewObject.FontSize = 200
zaxis = App.Vector(0, 0, 1)
t3 = ["Upside", "down"]
p3 = App.Vector(-1000, -500, 0)
place3 = App.Placement(p3, App.Rotation(zaxis, 180))
text3 = Draft.make_text(t3, place3)
text3.ViewObject.FontSize = 200
doc.recompute()